﻿Onion Text - A Final Fantasy III Text Editor
v1.2
by Chaos Rush

This program can edit the text in Final Fantasy III for the NES/Famicom.
It compiles all text banks at once in order to maximize free space
efficiency. The user does not have to worry about pointers or offsets
because this tool automatically does that for you.

This program supports:
* Final Fantasy III - English Translation (2019, by Chaos Rush)
* Final Fantasy III - Japanese version
* Final Fantasy III - MMC5 English Translation aka "Refurbished" (2016, by Chaos Rush)

This program is NOT compatible with the AWJ and ad0220 translations.
-----------------------------------------------------------------------
BASIC INSTRUCTIONS:

HOW TO USE (English translated ROM):
1. Under the 'Character Table' drop-down menu, select, "日本語"
2. Click on 'Load ROM', then find your Final Fantasy III ROM
3. Select the text bank and message number that you would like to edit
4. Click on "Compile All Text Banks" to save changes to the ROM

HOW TO USE (Japanese ROM):
1. Under the 'Character Table' drop-down menu, select, "日本語"
2. Click on 'Load ROM', then find your Final Fantasy III ROM
3. Select the text bank and message number that you would like to edit
4. Click on "Compile All Text Banks" to save changes to the ROM

HOW TO USE (Making your own translation):
1. Once you've decided the character set that you will use,
select, modify the "tbl_extra.tbl" file in the "Onion Text Resources"
folder.
2. Under the 'Character Table' drop-down menu, select, "Extra"
3. Click on 'Load ROM', then find your Final Fantasy III ROM
4. Select the text bank and message number that you would like to edit
5. Click on "Compile All Text Banks" to save changes to the ROM
-----------------------------------------------------------------------

WHAT DOES EACH BUTTON DO?

* "Load Last Loaded ROM" - opens the ROM file that's indicated in config.ini,
which is in the Resources folder.

* "Load ROM" - opens the file select menu. Find your ROM and select it.

* "Character Table: " drop-down menu - the currently selected text table used to
interpret the text data.

* "Bank #" drop-down menu - select one of these to view the respective
text bank's messages.

* "Message #" drop-down menu - select one of these to view a message.

* "Save Changes to Temporary Memory" - will temporarily save what you have
typed while the program is still open. This button does NOT compile anything
to the ROM. All it does is that whatever changes you made will be
retained if you view another message in the same bank and then go back
to the one you edited. (Note that if you switch to a different text bank,
your changes will not be saved)

* "Import Bank" - imports entire text bank from an external text file
located in the Onion Text Resources folder.

* "Export Bank" - exports entire text bank to an external text file
located in the Onion Text Resources folder.

* "Compile All Text Banks" - recompiles all text banks into the ROM.

* "Four Lines [up]" - shift the text preview four lines up.

* "Four Lines [down]" - shift the text preview four lines down.

* "Update Text Preview" - refresh the text preview box with the changes
you have made to the currently selected message number.

* "Line Formatting Check" - will check every line in the saved text bank
to make sure that line breaks are formatted correctly. Note this does not
account for text overflow.
-----------------------------------------------------------------------
OTHER INFORMATION:

* Note that modifying the Japanese table file won't affect how it shows
up in the text editor because I had to hardcode parts of it, due to the
IDE I'm using having issues with showing Japanese text properly when
reading it from an external text file.